/*
 * The Yard Utilties - http://www.theyard.net/
 * 
 * Copyright (c) 2008 by Vlideshow, Inc..  All Rights Resrved.
 * 
 * This library is free software; you can redistribute it and/or modify it under the 
 * terms of the GNU Lesser General Public License as published by the Free Software 
 * Foundation; either version 2.1 of the License, or (at your option) any later 
 * version. 
 * 
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY 
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 
 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License along 
 * with this library; if not, write to the Free Software Foundation, Inc., 
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */
package net.theyard.components.netstreamsm
{
  import net.theyard.components.sm.State;
  import flash.net.NetStream;

  /**
   * The set of transitions that any state in the NetStreamStateMachine must handle.
   *
   * @see NetStreamStateMachine
   */
  public interface StreamState extends State
  {
    /**
     * Transition: caused by a call by the user of the NetStreamStateMachine
     */
    function play(ns:NetStream, name: Object, ...args):void;
    /**
     * Transition: caused by a call by the user of the NetStreamStateMachine
     */
    function publish(ns:NetStream, name:String, publishType:String):void;
    /**
     * Transition: caused by a call by the user of the NetStreamStateMachine
     */
    function stop(ns:NetStream):void;
    /**
     * Transition: caused by a call by the user of the NetStreamStateMachine
     */
    function togglePause(ns:NetStream):void;

    /**
     * Transition: caused by an asynchronous callback from a NetStream
     */
    function onDisconnect(ns:NetStream):void;
    /**
     * Transition: caused by an asynchronous callback from a NetStream
     */
    function onPlayStart(ns:NetStream):void;
    /**
     * Transition: caused by an asynchronous callback from a NetStream
     */
    function onPublishStart(ns:NetStream):void;
    /**
     * Transition: caused by an asynchronous callback from a NetStream
     */
    function onPlayStop(ns: NetStream) :void;
    /**
     * Transition: caused by an asynchronous callback from a NetStream
     */
    function onPublishStop(ns : NetStream) : void;
    /**
     * Transition: caused by an asynchronous callback from a NetStream
     */
    function onReconnect():void;
  }
}
